home *** CD-ROM | disk | FTP | other *** search
/ Software Vault: The Gold Collection / Software Vault - The Gold Collection (American Databankers) (1993).ISO / cdr07 / oleo130s.zip / OLEO130S.TAR / oleo-1.3 / random.c < prev    next >
C/C++ Source or Header  |  1992-12-28  |  13KB  |  394 lines
  1. /*
  2.  * Copyright (c) 1983 Regents of the University of California.
  3.  * All rights reserved.
  4.  *
  5.  * Redistribution and use in source and binary forms are permitted
  6.  * provided that the above copyright notice and this paragraph are
  7.  * duplicated in all such forms and that any documentation,
  8.  * advertising materials, and other materials related to such
  9.  * distribution and use acknowledge that the software was developed
  10.  * by the University of California, Berkeley.  The name of the
  11.  * University may not be used to endorse or promote products derived
  12.  * from this software without specific prior written permission.
  13.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND WITHOUT ANY EXPRESS OR
  14.  * IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
  15.  * WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR A PARTICULAR PURPOSE.
  16.  */
  17.  
  18. #if defined(LIBC_SCCS) && !defined(lint)
  19. static char sccsid[] = "@(#)random.c    5.5 (Berkeley) 7/6/88";
  20. #endif /* LIBC_SCCS and not lint */
  21.  
  22. #include <stdio.h>
  23.  
  24. /*
  25.  * random.c:
  26.  * An improved random number generation package.  In addition to the standard
  27.  * rand()/srand() like interface, this package also has a special state info
  28.  * interface.  The initstate() routine is called with a seed, an array of
  29.  * bytes, and a count of how many bytes are being passed in; this array is then
  30.  * initialized to contain information for random number generation with that
  31.  * much state information.  Good sizes for the amount of state information are
  32.  * 32, 64, 128, and 256 bytes.  The state can be switched by calling the
  33.  * setstate() routine with the same array as was initiallized with initstate().
  34.  * By default, the package runs with 128 bytes of state information and
  35.  * generates far better random numbers than a linear congruential generator.
  36.  * If the amount of state information is less than 32 bytes, a simple linear
  37.  * congruential R.N.G. is used.
  38.  * Internally, the state information is treated as an array of longs; the
  39.  * zeroeth element of the array is the type of R.N.G. being used (small
  40.  * integer); the remainder of the array is the state information for the
  41.  * R.N.G.  Thus, 32 bytes of state information will give 7 longs worth of
  42.  * state information, which will allow a degree seven polynomial.  (Note: the
  43.  * zeroeth word of state information also has some other information stored
  44.  * in it -- see setstate() for details).
  45.  * The random number generation technique is a linear feedback shift register
  46.  * approach, employing trinomials (since there are fewer terms to sum up that
  47.  * way).  In this approach, the least significant bit of all the numbers in
  48.  * the state table will act as a linear feedback shift register, and will have
  49.  * period 2^deg - 1 (where deg is the degree of the polynomial being used,
  50.  * assuming that the polynomial is irreducible and primitive).  The higher
  51.  * order bits will have longer periods, since their values are also influenced
  52.  * by pseudo-random carries out of the lower bits.  The total period of the
  53.  * generator is approximately deg*(2**deg - 1); thus doubling the amount of
  54.  * state information has a vast influence on the period of the generator.
  55.  * Note: the deg*(2**deg - 1) is an approximation only good for large deg,
  56.  * when the period of the shift register is the dominant factor.  With deg
  57.  * equal to seven, the period is actually much longer than the 7*(2**7 - 1)
  58.  * predicted by this formula.
  59.  */
  60.  
  61.  
  62.  
  63. /*
  64.  * For each of the currently supported random number generators, we have a
  65.  * break value on the amount of state information (you need at least this
  66.  * many bytes of state info to support this random number generator), a degree
  67.  * for the polynomial (actually a trinomial) that the R.N.G. is based on, and
  68.  * the separation between the two lower order coefficients of the trinomial.
  69.  */
  70.  
  71. #define        TYPE_0        0    /* linear congruential */
  72. #define        BREAK_0        8
  73. #define        DEG_0        0
  74. #define        SEP_0        0
  75.  
  76. #define        TYPE_1        1    /* x**7 + x**3 + 1 */
  77. #define        BREAK_1        32
  78. #define        DEG_1        7
  79. #define        SEP_1        3
  80.  
  81. #define        TYPE_2        2    /* x**15 + x + 1 */
  82. #define        BREAK_2        64
  83. #define        DEG_2        15
  84. #define        SEP_2        1
  85.  
  86. #define        TYPE_3        3    /* x**31 + x**3 + 1 */
  87. #define        BREAK_3        128
  88. #define        DEG_3        31
  89. #define        SEP_3        3
  90.  
  91. #define        TYPE_4        4    /* x**63 + x + 1 */
  92. #define        BREAK_4        256
  93. #define        DEG_4        63
  94. #define        SEP_4        1
  95.  
  96.  
  97. /*
  98.  * Array versions of the above information to make code run faster -- relies
  99.  * on fact that TYPE_i == i.
  100.  */
  101.  
  102. #define        MAX_TYPES    5    /* max number of types above */
  103.  
  104. static int degrees[MAX_TYPES] =
  105. {DEG_0, DEG_1, DEG_2,
  106.  DEG_3, DEG_4};
  107.  
  108. static int seps[MAX_TYPES] =
  109. {SEP_0, SEP_1, SEP_2,
  110.  SEP_3, SEP_4};
  111.  
  112.  
  113.  
  114. /*
  115.  * Initially, everything is set up as if from :
  116.  *        initstate( 1, &randtbl, 128 );
  117.  * Note that this initialization takes advantage of the fact that srandom()
  118.  * advances the front and rear pointers 10*rand_deg times, and hence the
  119.  * rear pointer which starts at 0 will also end up at zero; thus the zeroeth
  120.  * element of the state information, which contains info about the current
  121.  * position of the rear pointer is just
  122.  *    MAX_TYPES*(rptr - state) + TYPE_3 == TYPE_3.
  123.  */
  124.  
  125. static long randtbl[DEG_3 + 1] =
  126. {TYPE_3,
  127.  0x9a319039, 0x32d9c024, 0x9b663182, 0x5da1f342,
  128.  0xde3b81e0, 0xdf0a6fb5, 0xf103bc02, 0x48f340fb,
  129.  0x7449e56b, 0xbeb1dbb0, 0xab5c5918, 0x946554fd,
  130.  0x8c2e680f, 0xeb3d799f, 0xb11ee0b7, 0x2d436b86,
  131.  0xda672e2a, 0x1588ca88, 0xe369735d, 0x904f35f7,
  132.  0xd7158fd6, 0x6fa6f051, 0x616e6b96, 0xac94efdc,
  133.  0x36413f93, 0xc622c298, 0xf5a42ab8, 0x8a88d77b,
  134.  0xf5ad9d0e, 0x8999220b, 0x27fb47b9};
  135.  
  136. /*
  137.  * fptr and rptr are two pointers into the state info, a front and a rear
  138.  * pointer.  These two pointers are always rand_sep places aparts, as they cycle
  139.  * cyclically through the state information.  (Yes, this does mean we could get
  140.  * away with just one pointer, but the code for random() is more efficient this
  141.  * way).  The pointers are left positioned as they would be from the call
  142.  *            initstate( 1, randtbl, 128 )
  143.  * (The position of the rear pointer, rptr, is really 0 (as explained above
  144.  * in the initialization of randtbl) because the state table pointer is set
  145.  * to point to randtbl[1] (as explained below).
  146.  */
  147.  
  148. static long *fptr = &randtbl[SEP_3 + 1];
  149. static long *rptr = &randtbl[1];
  150.  
  151.  
  152.  
  153. /*
  154.  * The following things are the pointer to the state information table,
  155.  * the type of the current generator, the degree of the current polynomial
  156.  * being used, and the separation between the two pointers.
  157.  * Note that for efficiency of random(), we remember the first location of
  158.  * the state information, not the zeroeth.  Hence it is valid to access
  159.  * state[-1], which is used to store the type of the R.N.G.
  160.  * Also, we remember the last location, since this is more efficient than
  161.  * indexing every time to find the address of the last element to see if
  162.  * the front and rear pointers have wrapped.
  163.  */
  164.  
  165. static long *state = &randtbl[1];
  166.  
  167. static int rand_type = TYPE_3;
  168. static int rand_deg = DEG_3;
  169. static int rand_sep = SEP_3;
  170.  
  171. static long *end_ptr = &randtbl[DEG_3 + 1];
  172.  
  173.  
  174.  
  175. /*
  176.  * srandom:
  177.  * Initialize the random number generator based on the given seed.  If the
  178.  * type is the trivial no-state-information type, just remember the seed.
  179.  * Otherwise, initializes state[] based on the given "seed" via a linear
  180.  * congruential generator.  Then, the pointers are set to known locations
  181.  * that are exactly rand_sep places apart.  Lastly, it cycles the state
  182.  * information a given number of times to get rid of any initial dependencies
  183.  * introduced by the L.C.R.N.G.
  184.  * Note that the initialization of randtbl[] for default usage relies on
  185.  * values produced by this routine.
  186.  */
  187.  
  188. srandom (x)
  189.  
  190.      unsigned x;
  191. {
  192.   register int i;
  193.   long random ();
  194.  
  195.   if (rand_type == TYPE_0)
  196.     {
  197.       state[0] = x;
  198.     }
  199.   else
  200.     {
  201.       state[0] = x;
  202.       for (i = 1; i < rand_deg; i++)
  203.     {
  204.       state[i] = 1103515245 * state[i - 1] + 12345;
  205.     }
  206.       fptr = &state[rand_sep];
  207.       rptr = &state[0];
  208.       for (i = 0; i < 10 * rand_deg; i++)
  209.     random ();
  210.     }
  211. }
  212.  
  213.  
  214.  
  215. /*
  216.  * initstate:
  217.  * Initialize the state information in the given array of n bytes for
  218.  * future random number generation.  Based on the number of bytes we
  219.  * are given, and the break values for the different R.N.G.'s, we choose
  220.  * the best (largest) one we can and set things up for it.  srandom() is
  221.  * then called to initialize the state information.
  222.  * Note that on return from srandom(), we set state[-1] to be the type
  223.  * multiplexed with the current value of the rear pointer; this is so
  224.  * successive calls to initstate() won't lose this information and will
  225.  * be able to restart with setstate().
  226.  * Note: the first thing we do is save the current state, if any, just like
  227.  * setstate() so that it doesn't matter when initstate is called.
  228.  * Returns a pointer to the old state.
  229.  */
  230.  
  231. char *
  232. initstate (seed, arg_state, n)
  233.  
  234.      unsigned seed;        /* seed for R. N. G. */
  235.      char *arg_state;        /* pointer to state array */
  236.      int n;            /* # bytes of state info */
  237. {
  238.   register char *ostate = (char *) (&state[-1]);
  239.  
  240.   if (rand_type == TYPE_0)
  241.     state[-1] = rand_type;
  242.   else
  243.     state[-1] = MAX_TYPES * (rptr - state) + rand_type;
  244.   if (n < BREAK_1)
  245.     {
  246.       if (n < BREAK_0)
  247.     {
  248.       fprintf (stderr, "initstate: not enough state (%d bytes) with which to do jack; ignored.\n", n);
  249.       return 0;
  250.     }
  251.       rand_type = TYPE_0;
  252.       rand_deg = DEG_0;
  253.       rand_sep = SEP_0;
  254.     }
  255.   else
  256.     {
  257.       if (n < BREAK_2)
  258.     {
  259.       rand_type = TYPE_1;
  260.       rand_deg = DEG_1;
  261.       rand_sep = SEP_1;
  262.     }
  263.       else
  264.     {
  265.       if (n < BREAK_3)
  266.         {
  267.           rand_type = TYPE_2;
  268.           rand_deg = DEG_2;
  269.           rand_sep = SEP_2;
  270.         }
  271.       else
  272.         {
  273.           if (n < BREAK_4)
  274.         {
  275.           rand_type = TYPE_3;
  276.           rand_deg = DEG_3;
  277.           rand_sep = SEP_3;
  278.         }
  279.           else
  280.         {
  281.           rand_type = TYPE_4;
  282.           rand_deg = DEG_4;
  283.           rand_sep = SEP_4;
  284.         }
  285.         }
  286.     }
  287.     }
  288.   state = &(((long *) arg_state)[1]);    /* first location */
  289.   end_ptr = &state[rand_deg];    /* must set end_ptr before srandom */
  290.   srandom (seed);
  291.   if (rand_type == TYPE_0)
  292.     state[-1] = rand_type;
  293.   else
  294.     state[-1] = MAX_TYPES * (rptr - state) + rand_type;
  295.   return (ostate);
  296. }
  297.  
  298.  
  299.  
  300. /*
  301.  * setstate:
  302.  * Restore the state from the given state array.
  303.  * Note: it is important that we also remember the locations of the pointers
  304.  * in the current state information, and restore the locations of the pointers
  305.  * from the old state information.  This is done by multiplexing the pointer
  306.  * location into the zeroeth word of the state information.
  307.  * Note that due to the order in which things are done, it is OK to call
  308.  * setstate() with the same state as the current state.
  309.  * Returns a pointer to the old state information.
  310.  */
  311.  
  312. char *
  313. setstate (arg_state)
  314.  
  315.      char *arg_state;
  316. {
  317.   register long *new_state = (long *) arg_state;
  318.   register int type = new_state[0] % MAX_TYPES;
  319.   register int rear = new_state[0] / MAX_TYPES;
  320.   char *ostate = (char *) (&state[-1]);
  321.  
  322.   if (rand_type == TYPE_0)
  323.     state[-1] = rand_type;
  324.   else
  325.     state[-1] = MAX_TYPES * (rptr - state) + rand_type;
  326.   switch (type)
  327.     {
  328.     case TYPE_0:
  329.     case TYPE_1:
  330.     case TYPE_2:
  331.     case TYPE_3:
  332.     case TYPE_4:
  333.       rand_type = type;
  334.       rand_deg = degrees[type];
  335.       rand_sep = seps[type];
  336.       break;
  337.  
  338.     default:
  339.       fprintf (stderr, "setstate: state info has been munged; not changed.\n");
  340.     }
  341.   state = &new_state[1];
  342.   if (rand_type != TYPE_0)
  343.     {
  344.       rptr = &state[rear];
  345.       fptr = &state[(rear + rand_sep) % rand_deg];
  346.     }
  347.   end_ptr = &state[rand_deg];    /* set end_ptr too */
  348.   return (ostate);
  349. }
  350.  
  351.  
  352.  
  353. /*
  354.  * random:
  355.  * If we are using the trivial TYPE_0 R.N.G., just do the old linear
  356.  * congruential bit.  Otherwise, we do our fancy trinomial stuff, which is the
  357.  * same in all ther other cases due to all the global variables that have been
  358.  * set up.  The basic operation is to add the number at the rear pointer into
  359.  * the one at the front pointer.  Then both pointers are advanced to the next
  360.  * location cyclically in the table.  The value returned is the sum generated,
  361.  * reduced to 31 bits by throwing away the "least random" low bit.
  362.  * Note: the code takes advantage of the fact that both the front and
  363.  * rear pointers can't wrap on the same call by not testing the rear
  364.  * pointer if the front one has wrapped.
  365.  * Returns a 31-bit random number.
  366.  */
  367.  
  368. long
  369. random ()
  370. {
  371.   long i;
  372.  
  373.   if (rand_type == TYPE_0)
  374.     {
  375.       i = state[0] = (state[0] * 1103515245 + 12345) & 0x7fffffff;
  376.     }
  377.   else
  378.     {
  379.       *fptr += *rptr;
  380.       i = (*fptr >> 1) & 0x7fffffff;    /* chucking least random bit */
  381.       if (++fptr >= end_ptr)
  382.     {
  383.       fptr = state;
  384.       ++rptr;
  385.     }
  386.       else
  387.     {
  388.       if (++rptr >= end_ptr)
  389.         rptr = state;
  390.     }
  391.     }
  392.   return (i);
  393. }
  394.